Repository navigation
README: sections for the most-used APIs it did not cover, OCR first - #94
Merged
Merged
Conversation
Adds complete programs, each with a row in the Tasks table, for OCR (a new "OCR a scanned PDF in C#" section next to text extraction), email metadata, updating a Word table of contents, PDF/UA, PDF metadata, text to PDF, combining images into one PDF, HEIC to JPG, web page screenshots, Markdown in both directions and AI data extraction. One sentence each points to other image formats, Word to TXT or HTML, Excel to CSV and the API reference, and an "Also available" list links e-invoices, QR codes and barcodes, PDF crop and PDF/A validation. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
There was a problem hiding this comment.
🟢 Approval recommended
No active review issues are identified for this README-only update expanding conversion examples and guidance.
No open issues 🎉
What changed in this PR
Expands the .NET SDK README with examples for previously uncovered ConvertAPI tasks, prioritizing OCR for scanned PDFs. No library or example-project code changes.
Changes:
- Adds complete C# snippets for OCR, image and Markdown conversions, PDF accessibility, metadata extraction, AI data extraction, and Word table-of-contents updates.
- Adds Tasks table links and guidance on format alternatives and conversion options.
- Links to additional converters for e-invoices, QR codes, barcodes, PDF cropping, and PDF/A validation.
| File | Description |
|---|---|
| README.md | Adds conversion examples, navigation links, parameter guidance, and links to further API documentation. |
Review effort: Balanced
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What this adds
Complete programs for the most-used ConvertAPI conversions that the README did not cover yet. Each one reads
CONVERTAPI_TOKEN, saves tooutputlike the existing snippets, and has a row in the Tasks table:pdf/to/ocr): a new task section right after "Extract text from PDF in C#".images/to/pdfwithFiles)txt/to/pdf)heic/to/jpg)html/to/pngwithUrl)pdf/to/md,md/to/pdf)pdf/to/pdfua)pdf/to/meta)pdf/to/extractwithDocumentType)email/to/metadata)docx/to/docxwithUpdateTableOfContentsandUpdateReferences)"tiff"also takes TIF files."txt"or"html"in place of"pdf"."csv"in place of"pdf", one CSV per worksheet.Only README.md changes. Example projects for the README's "... in C#" tasks and for OCR follow in a second pull request after this one merges.
How each snippet was checked
Program.csof a new console project with ConvertApi 3.2.2 from nuget.org, against the staging API on 2026-11-11, with made-up sample files. The uploaded and result files were deleted after each run.output/scanned.pdf, 149,869 bytes, with a text layeroutput/page1.pdf, 206,902 bytes, 2 A4 pagesoutput/notes.pdf, 37,496 bytesoutput/photo.jpg, 17,117 bytes, 1200 x 800output/cdn_convertapi_com.png, 1,220,402 bytes, the whole pageImages=remove)output/document.md, 3,017 bytesoutput/document.pdf, 64,798 bytesoutput/document.pdf, 803,710 bytes, tagged,pdfuaid:part1output/document.json, 241 bytesoutput/invoice.json, 1,495 bytesoutput/email.json, 1,159 bytesoutput/report.docx, 13,609 bytes, TOC and cross-reference updated.tiffile, GIF, HEIC and WEBP to PDF; DOCX to TXT and HTML; XLSX to CSV; HEIC to PNG; a web page to JPG; DOCX, PPTX, XLSX and HTML to Markdown; and PDF/UA from an untagged PDF. 16 of 16 passed.python3 .github/ci/check_csharp.py readme-build: 56 of 56 blocks build. In the Examples workflow, "OCR a scanned PDF in C#" runs like the other "... in C#" blocks, withtest.pdfcopied in asscanned.pdf: one more conversion per job. The new####blocks are built only.Choices worth a look
deandesas language examples, because the spec currently lists French asfaand the API rejectsfr.OcrQuality(fast) left out the table's text andenhancedread all of it. The section keeps the default and says when to addenhanced.images/to/pdfgives every page the same size and orientation, so a portrait scan next to a landscape photo is letterboxed. The section says so and namesPageOrientation.pdf/to/mdembeds images as base64 by default (345 KB for the 6-pageExamples/TestFiles/test.pdf). The snippet usesImages=remove(3 KB), which the spec describes as the compact output for machine processing, and the text names the default anddescribe.Not changed: the library, the examples, build.yml, CHANGELOG.md and RELEASING.md.
🤖 Generated with Claude Code